<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dppsu: xdppsu_common_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dppsu
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xdppsu__common__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xdppsu_common_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>Contains a design example using the <a class="el" href="struct_x_dp_psu.html" title="The XDpPsu driver instance data. ">XDpPsu</a> driver. </p>
<p>It performs a self test on the DisplayPort TX core by training the main link at the maximum common capabilities between the TX and RX and checking the lane status.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.0   aad  09/17/17 Initial creation.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a05b560a8593f7a81eee6df4151d8ba4f"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdppsu__common__example_8c.html#a05b560a8593f7a81eee6df4151d8ba4f">DpPsu_Run</a> (<a class="el" href="struct_x_dp_psu.html">XDpPsu</a> *InstancePtr)</td></tr>
<tr class="memdesc:a05b560a8593f7a81eee6df4151d8ba4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will configure and establish a link with the receiver device, afterwards, a video stream will start to be sent over the main link.  <a href="#a05b560a8593f7a81eee6df4151d8ba4f">More...</a><br/></td></tr>
<tr class="separator:a05b560a8593f7a81eee6df4151d8ba4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab974530daf60911aba3ef16148bd85ad"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdppsu__common__example_8c.html#ab974530daf60911aba3ef16148bd85ad">DpPsu_SetupExample</a> (<a class="el" href="struct_x_dp_psu.html">XDpPsu</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="memdesc:ab974530daf60911aba3ef16148bd85ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will setup and initialize the DisplayPort TX core.  <a href="#ab974530daf60911aba3ef16148bd85ad">More...</a><br/></td></tr>
<tr class="separator:ab974530daf60911aba3ef16148bd85ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64d2267afa217a44aa3bf09bcd51e409"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdppsu__common__example_8c.html#a64d2267afa217a44aa3bf09bcd51e409">DpPsu_StartLink</a> (<a class="el" href="struct_x_dp_psu.html">XDpPsu</a> *InstancePtr)</td></tr>
<tr class="memdesc:a64d2267afa217a44aa3bf09bcd51e409"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will configure and establish a link with the receiver device.  <a href="#a64d2267afa217a44aa3bf09bcd51e409">More...</a><br/></td></tr>
<tr class="separator:a64d2267afa217a44aa3bf09bcd51e409"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a05b560a8593f7a81eee6df4151d8ba4f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 DpPsu_Run </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dp_psu.html">XDpPsu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will configure and establish a link with the receiver device, afterwards, a video stream will start to be sent over the main link. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_dp_psu.html" title="The XDpPsu driver instance data. ">XDpPsu</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if main link was successfully established.</li>
<li>XST_FAILURE otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xdppsu__common__example_8c.html#a64d2267afa217a44aa3bf09bcd51e409">DpPsu_StartLink()</a>.</p>

</div>
</div>
<a class="anchor" id="ab974530daf60911aba3ef16148bd85ad"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 DpPsu_SetupExample </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dp_psu.html">XDpPsu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will setup and initialize the DisplayPort TX core. </p>
<p>The core's configuration parameters will be retrieved based on the configuration to the DisplayPort TX core instance with the specified device ID.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_dp_psu.html" title="The XDpPsu driver instance data. ">XDpPsu</a> instance. </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is the unique device ID of the DisplayPort TX core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the device configuration was found and obtained and if the main link was successfully established.</li>
<li>XST_FAILURE otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dp_psu___config.html#a59991a74d33038e382665a3460a669ee">XDpPsu_Config::BaseAddr</a>, <a class="el" href="xdppsu_8c.html#a619d7de707e733f244b8eeaf8dbc8377">XDpPsu_CfgInitialize()</a>, <a class="el" href="xdppsu_8c.html#a2602de9c767cd981896326433a3c2570">XDpPsu_InitializeTx()</a>, and <a class="el" href="xdppsu_8h.html#af6dbe680949ea8a0e857c916d870584b">XDpPsu_LookupConfig()</a>.</p>

<p>Referenced by <a class="el" href="xdppsu__intr__example_8c.html#a53e626bd69c448d2034d784209700cb2">DpPsu_IntrExample()</a>, and <a class="el" href="xdppsu__poll__example_8c.html#a371a419786bfb9ca58b6ff057e93f846">DpPsu_PollExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a64d2267afa217a44aa3bf09bcd51e409"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 DpPsu_StartLink </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dp_psu.html">XDpPsu</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will configure and establish a link with the receiver device. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_dp_psu.html" title="The XDpPsu driver instance data. ">XDpPsu</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS the if main link was successfully established.</li>
<li>XST_FAILURE otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dp_psu___config.html#a59991a74d33038e382665a3460a669ee">XDpPsu_Config::BaseAddr</a>, <a class="el" href="struct_x_dp_psu.html#a95a9619caa3d18b50a4562de54d57704">XDpPsu::Config</a>, <a class="el" href="struct_x_dp_psu___link_config.html#a1e61b94ec7a7329b4b7929251b293e79">XDpPsu_LinkConfig::LaneCount</a>, <a class="el" href="struct_x_dp_psu.html#a37e28c28f46f7e08ce4738a9232a0678">XDpPsu::LinkConfig</a>, <a class="el" href="struct_x_dp_psu___link_config.html#ae1994c57d3126737fc0028f5039b62be">XDpPsu_LinkConfig::LinkRate</a>, <a class="el" href="struct_x_dp_psu___link_config.html#a0953d4a5c490da688eb7d4636f918712">XDpPsu_LinkConfig::MaxLaneCount</a>, <a class="el" href="struct_x_dp_psu___link_config.html#a7add556a95dbf238f21ae156bfd284f3">XDpPsu_LinkConfig::MaxLinkRate</a>, <a class="el" href="xdppsu_8c.html#a3d4cefedd9d272f58c7927b72add609d">XDpPsu_CfgMainLinkMax()</a>, <a class="el" href="xdppsu_8c.html#ae723bbc24a4dbce124cdd92979af27af">XDpPsu_CheckLinkStatus()</a>, <a class="el" href="xdppsu_8c.html#abe31bd9b101b094a40eff13ef032ea44">XDpPsu_EstablishLink()</a>, <a class="el" href="xdppsu_8c.html#a0a935cce246619f8f43ea0794ed9fa8e">XDpPsu_GetRxCapabilities()</a>, <a class="el" href="xdppsu__hw_8h.html#a39533d8f8e18fce7b13f84d440b6b176">XDPPSU_LINK_BW_SET</a>, <a class="el" href="xdppsu__hw_8h.html#a236d6b24b5cf2e0e8ac65a4079ae93bc">XDpPsu_ReadReg</a>, <a class="el" href="xdppsu_8c.html#a7836168f290562156a24fb51762acde4">XDpPsu_SetDownspread()</a>, <a class="el" href="xdppsu_8c.html#a2ec5ae4af1f5232fc86116d457045997">XDpPsu_SetEnhancedFrameMode()</a>, <a class="el" href="xdppsu_8c.html#a868ca9bd2184707f3929e6f7e695cc93">XDpPsu_SetLaneCount()</a>, and <a class="el" href="xdppsu_8c.html#a68384c6a808dff1f2e68e7611057a548">XDpPsu_SetLinkRate()</a>.</p>

<p>Referenced by <a class="el" href="xdppsu__common__example_8h.html#a05b560a8593f7a81eee6df4151d8ba4f">DpPsu_Run()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
